home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / include / Dt / Help.h.z / Help.h
Encoding:
C/C++ Source or Header  |  2003-11-18  |  6.8 KB  |  269 lines
  1. /*
  2.  * Help.h
  3.  *
  4.  * Copyright 2000, Silicon Graphics, Inc.
  5.  * ALL RIGHTS RESERVED
  6.  * 
  7.  * UNPUBLISHED -- Rights reserved under the copyright laws of the United
  8.  * States.   Use of a copyright notice is precautionary only and does not
  9.  * imply publication or disclosure.
  10.  *
  11.  * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
  12.  * Use, duplication or disclosure by the Government is subject to restrictions
  13.  * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
  14.  * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
  15.  * in similar or successor clauses in the FAR, or the DOD or NASA FAR
  16.  * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
  17.  * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
  18.  *
  19.  * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
  20.  * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
  21.  * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
  22.  * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
  23.  * GRAPHICS, INC.
  24.  */
  25. /* $XConsortium: Help.h /main/cde1_maint/1 1995/07/17 17:34:46 drk $ */
  26. /*
  27.  *  (c) Copyright 1993, 1994 Hewlett-Packard Company
  28.  *  (c) Copyright 1993, 1994 International Business Machines Corp.
  29.  *  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  30.  *  (c) Copyright 1993, 1994 Novell, Inc.
  31.  */
  32.  
  33. #ifndef _Dt_Help_h
  34. #define _Dt_Help_h
  35.  
  36. #include <X11/Intrinsic.h>
  37.  
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41.  
  42.  
  43. /*
  44.  * Constants
  45.  */
  46.  
  47. /* Common DtHelp Resources  */
  48.  
  49. #ifndef DtNcloseCallback
  50. #define DtNcloseCallback       "closeCallback"
  51. #endif
  52. #ifndef DtNcolumns
  53. #define DtNcolumns                 XmNcolumns
  54. #endif
  55. #ifndef DtNexecutionPolicy
  56. #define DtNexecutionPolicy         "executionPolicy"
  57. #endif
  58. #ifndef DtNhelpFile
  59. #define DtNhelpFile                "helpFile"
  60. #endif
  61. #ifndef DtNhelpOnHelpVolume
  62. #define DtNhelpOnHelpVolume        "helpOnHelpVolume"
  63. #endif
  64. #ifndef DtNhelpPrint
  65. #define DtNhelpPrint               "helpPrint"
  66. #endif
  67. #ifndef DtNhelpType
  68. #define DtNhelpType                "helpType"
  69. #endif
  70. #ifndef DtNhelpVolume
  71. #define DtNhelpVolume              "helpVolume"
  72. #endif
  73. #ifndef DtNhyperLinkCallback
  74. #define DtNhyperLinkCallback       "hyperLinkCallback"
  75. #endif
  76. #ifndef DtNlocationId
  77. #define DtNlocationId              "locationId"
  78. #endif
  79. #ifndef DtNmanPage
  80. #define DtNmanPage                 "manPage"
  81. #endif
  82. #ifndef DtNminimizeButtons
  83. #define DtNminimizeButtons         XmNminimizeButtons
  84. #endif
  85. #ifndef DtNpaperSize
  86. #define DtNpaperSize               "paperSize"
  87. #endif
  88. #ifndef DtNprinter
  89. #define DtNprinter                 "printer"
  90. #endif
  91. #ifndef DtNrows
  92. #define DtNrows                    XmNrows
  93. #endif
  94. #ifndef DtNscrollBarPolicy
  95. #define DtNscrollBarPolicy         "scrollBarPolicy"
  96. #endif
  97. #ifndef DtNstringData
  98. #define DtNstringData              "stringData"
  99. #endif
  100.  
  101. #ifndef DtCCallback
  102. #define DtCCallback                XmCCallback
  103. #endif
  104.  
  105. #ifndef DtCCloseCallback
  106. #define DtCCloseCallback       "CloseCallback"
  107. #endif
  108. #ifndef DtCColumns
  109. #define DtCColumns                 XmCColumns
  110. #endif
  111. #ifndef DtCExecutionPolicy
  112. #define DtCExecutionPolicy         "ExecutionPolicy"
  113. #endif
  114. #ifndef DtCHelpFile
  115. #define DtCHelpFile                "HelpFile"
  116. #endif
  117. #ifndef DtCHelpOnHelpVolume
  118. #define DtCHelpOnHelpVolume       "HelpOnHelpVolume"
  119. #endif
  120. #ifndef DtCHelpPrint
  121. #define DtCHelpPrint               "HelpPrint"
  122. #endif
  123. #ifndef DtCHelpType
  124. #define DtCHelpType                "HelpType"
  125. #endif
  126. #ifndef DtCHelpVolume
  127. #define DtCHelpVolume              "HelpVolume"
  128. #endif
  129. #ifndef DtCHyperLinkCallback
  130. #define DtCHyperLinkCallback       "HyperLinkCallback"
  131. #endif
  132. #ifndef DtCLocationId
  133. #define DtCLocationId              "LocationId"
  134. #endif
  135. #ifndef DtCManPage
  136. #define DtCManPage                 "ManPage"
  137. #endif
  138. #ifndef DtCMinimizeButtons
  139. #define DtCMinimizeButtons         XmCMinimizeButtons
  140. #endif
  141. #ifndef DtCPaperSize
  142. #define DtCPaperSize               "PaperSize"
  143. #endif
  144. #ifndef DtCPrinter
  145. #define DtCPrinter                 "Printer"
  146. #endif
  147. #ifndef DtCRows
  148. #define DtCRows                    XmCRows
  149. #endif
  150. #ifndef DtCScrollBarPolicy
  151. #define DtCScrollBarPolicy         "ScrollBarPolicy"
  152. #endif
  153. #ifndef DtCStringData
  154. #define DtCStringData              "StringData"
  155. #endif
  156.  
  157. /* Representation types */
  158.  
  159. #ifndef DtRDtExecutionPolicy
  160. #define DtRDtExecutionPolicy         "DtExecutionPolicy"
  161. #endif
  162. #ifndef DtRDtHelpType
  163. #define DtRDtHelpType                "DtHelpType"
  164. #endif
  165. #ifndef DtRDtPaperSize
  166. #define DtRDtPaperSize               "DtPaperSize"
  167. #endif
  168. #ifndef DtRDtScrollBarPolicy
  169. #define DtRDtScrollBarPolicy         "DtScrollBarPolicy"
  170. #endif
  171.  
  172. /* DtHelpDialogCallbackStruct windowHint field */
  173.  
  174. #define DtHELP_POPUP_WINDOW       1
  175. #define DtHELP_CURRENT_WINDOW     2
  176. #define DtHELP_NEW_WINDOW         3
  177.  
  178. /* DtHelpDialogCallbackStruct hyperType field */
  179.  
  180. #define DtHELP_LINK_JUMP_NEW          1
  181. #define DtHELP_LINK_TOPIC             1
  182. #define DtHELP_LINK_MAN_PAGE          4
  183. #define DtHELP_LINK_APP_DEFINE        5
  184. #define DtHELP_LINK_TEXT_FILE         8
  185.  
  186. /* DtHelpDialogCallbackStruct reason field */
  187.  
  188. #define DtCR_HELP_LINK_ACTIVATE      1
  189. #define DtCR_HELP_CLOSE              2
  190. #define DtCR_HELP_HELP               3
  191.  
  192. /* Possible values for DtNscrollBarPolicy resource */
  193.  
  194. #define  DtHELP_NO_SCROLLBARS        0
  195. #define  DtHELP_STATIC_SCROLLBARS    1
  196. #define  DtHELP_AS_NEEDED_SCROLLBARS 2
  197.  
  198. /* Possible values for DtNexecutionPolicy resource */
  199. #define  DtHELP_EXECUTE_NONE            0
  200. #define  DtHELP_EXECUTE_QUERY_ALL        1
  201. #define  DtHELP_EXECUTE_QUERY_UNALIASED        2
  202. #define  DtHELP_EXECUTE_ALL            3
  203.  
  204. /* Possible values for DtNhelpType resource */
  205.  
  206. #define DtHELP_TYPE_TOPIC           0
  207. #define DtHELP_TYPE_STRING          1
  208. #define DtHELP_TYPE_MAN_PAGE        2
  209. #define DtHELP_TYPE_FILE            3
  210. #define DtHELP_TYPE_DYNAMIC_STRING  4
  211.  
  212. /* Possible values for DtNpaperSize resource */
  213.  
  214. #define DtHELP_PAPERSIZE_LETTER     0
  215. #define DtHELP_PAPERSIZE_LEGAL      1
  216. #define DtHELP_PAPERSIZE_EXECUTIVE  2
  217. #define DtHELP_PAPERSIZE_A4         3
  218. #define DtHELP_PAPERSIZE_B5         4
  219.  
  220. /* DtHelpQuickGetChildGetChild() function */
  221.  
  222. #define DtHELP_QUICK_CLOSE_BUTTON    1
  223. #define DtHELP_QUICK_PRINT_BUTTON    2
  224. #define DtHELP_QUICK_HELP_BUTTON     3
  225. #define DtHELP_QUICK_SEPARATOR       4
  226. #define DtHELP_QUICK_MORE_BUTTON     5
  227. #define DtHELP_QUICK_BACK_BUTTON     6
  228.  
  229. /* Return values for DtHelpReturnSelectedWidgetId() */
  230.  
  231. #define DtHELP_SELECT_ERROR   -1 
  232. #define DtHELP_SELECT_VALID    0
  233. #define DtHELP_SELECT_ABORT    1
  234. #define DtHELP_SELECT_INVALID  2 
  235.  
  236.  
  237. /*
  238.  * Types
  239.  */
  240.  
  241. typedef struct {
  242.     int    reason;
  243.     XEvent    *event;
  244.     char    *locationId;
  245.     char    *helpVolume;
  246.     char    *specification;
  247.     int    hyperType;
  248.     int    windowHint;
  249. } DtHelpDialogCallbackStruct;
  250.  
  251.  
  252. /*
  253.  * Functions
  254.  */
  255.  
  256. extern void DtHelpSetCatalogName(
  257.         char        *catFile);
  258.  
  259. extern int DtHelpReturnSelectedWidgetId(
  260.         Widget        parent,
  261.         Cursor        cursor,
  262.         Widget        *widget);
  263.  
  264. #ifdef __cplusplus
  265. }
  266. #endif
  267.  
  268. #endif /* _Dt_Help_h */
  269.